home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / EDITOR / ZKWIK11.ARJ / ZK.DOC < prev    next >
Text File  |  1991-12-04  |  11KB  |  277 lines
  1.  
  2.  
  3.  
  4.  
  5.                          ZK (formerly ZipKwik)
  6.                               release 1.1
  7.  
  8.  
  9.            KWIC (Key Word in Context) and KWOC (Key Word Out
  10.            of Context) indexing system for ASCII text files.
  11.  
  12.  
  13.                            S H A R E W A R E
  14.  
  15.  
  16.             ZK is shareware. If you use the program and find it useful,
  17.             please send $ 10.00 to the author at the address below:
  18.  
  19.             Clyde W. Grotophorst
  20.             Route 1, Box 296
  21.             Hamilton, VA 22068
  22.             USA
  23.  
  24.             Registered users gain extended access to the GMUtant
  25.             Software BBS (703) 993-2219 1200/2400/9600 v.32. You
  26.             will also be able to obtain assistance from the author
  27.             in using (or enhancing) ZK...
  28.  
  29.             Registered users may purchase ZK source code
  30.             for $ 15.00. Source code for ZK written in Turbo Pascal 6.0
  31.             To compile, you must have two TurboPower Software
  32.             products: Object Professional or Turbo Professional
  33.             and (for sort routines) B-Tree Filer (5.22)).
  34.  
  35.  
  36.            (c) 1991, Clyde W. Grotophorst, GMUtant Software
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51. QUICKSTART: To see what ZK can do, type ZK TESTFILE at your DOS prompt.
  52. A KWIC or KWOC index of the contents in TESTFILE will be created.
  53. Output filename: TESTFILE.QWK
  54.  
  55. ------------
  56. INTRODUCTION
  57. ------------
  58.  
  59. ZK is a program which produces KWIC (Key Word In Context) or KWOC (Key Word
  60. Out of Context) indexes from ASCII text files. Here's a sample of what
  61. ZK produces (using an listing of some magazine titles):
  62.  
  63. Before processing (a text file you create with your wordprocessor):
  64.  
  65. Fixing your Leading Edge PC Popular Mechanics Nov 79, p. 43-4
  66. Is KWIC better than KWOC? Index methods compared. ASIS Nov 1982 pg. 44-56.
  67. Who says you need a mainframe for KWIC indexing GMUtant News Jan 89 page 2
  68. Are KWIC indexes actually promoted by paper companies? True Stories Nov 88
  69.  
  70. After processing (a KWIC index, ZK output option #1):
  71.  
  72. Stories Nov 88 Are KWIC indexes ║ACTUALLY       ║promoted by paper companies? True
  73. n KWOC? Index methods compared. ║ASIS           ║Nov 1982 pg. 44-56. Is KWIC better tha
  74. Byte Oct 88, page 79 Pascal for ║BEGINNERS      ║
  75. SIS Nov 1982 pg. 44-56. Is KWIC ║BETTER         ║than KWOC? Index methods compared. A
  76. Interface: Findings of a survey ║BYTE           ║Nov 87 pg. 24-32 What is the User-
  77. 8, page 79 Pascal for Beginners ║BYTE           ║Oct 8
  78.  PC Magazine 12:14-17 Oct 1988  ║C              ║Compilers: A product review
  79. ove Sanscrit, you're halfway to ║C              ║programming. Micro 13:1 pg. 70+ If you know and l
  80. exes actually promoted by paper ║COMPANIES      ║True Stories Nov 88 Are KWIC ind
  81. better than KWOC? Index methods ║COMPARED       ║ASIS Nov 1982 pg. 44-56. Is KWIC 
  82. PC Magazine 12:14-17 Oct 1988 C ║COMPILERS      ║A product review 
  83. ng for the Perfect Sort Popular ║COMPUTING      ║Oct 87, pg. 19-23 Searchi
  84. 9, p. 43-4. Fixing your Leading ║EDGE           ║PC Popular Mechanics Nov 7
  85.  Apr 79, p. 2 Sort Routines for ║EVENING        ║Hours 80 Micro
  86. -32 What is the User-Interface: ║FINDINGS       ║of a survey BYTE Nov 87 pg. 24
  87. lar Mechanics Nov 79, p. 43-4.  ║FIXING         ║your Leading Edge PC Popu
  88. d a mainframe for KWIC indexing ║GMUTANT        ║News Jan 89 page 2 Who says you nee
  89.  know and love Sanscrit, you're ║HALFWAY        ║to C programming. Micro 13:1 pg. 70+ If you
  90. rogramming. Micro 13:1 pg. 70+  ║IF             ║you know and love Sanscrit, you're halfway to C p
  91. 4-56. Is KWIC better than KWOC? ║INDEX          ║methods compared. ASIS Nov 1982 pg. 4
  92. s? True Stories Nov 88 Are KWIC ║INDEXES        ║actually promoted by paper companie
  93. s you need a mainframe for KWIC ║INDEXING       ║GMUtant News Jan 89 page 2 Who say
  94. ming. Micro 13:1 pg. 70+ If you ║KNOW           ║and love Sanscrit, you're halfway to C program
  95. ed. ASIS Nov 1982 pg. 44-56. Is ║KWIC           ║better than KWOC? Index methods compar
  96. panies? True Stories Nov 88 Are ║KWIC           ║indexes actually promoted by paper com
  97. o says you need a mainframe for ║KWIC           ║indexing GMUtant News Jan 89 page 2 Wh
  98.  pg. 44-56. Is KWIC better than ║KWOC           ║Index methods compared. ASIS Nov 1982
  99.  
  100.  
  101. K W O C
  102.  
  103. Below an excerpt of a KWOC index (output option #3) appears:
  104.  
  105. ║ACTUALLY       ║  Are KWIC indexes ACTUALLY promoted by paper companies? True Stories Nov 88
  106. ║ASIS           ║  Is KWIC better than KWOC? Index methods compared. ASIS Nov 1982 pg. 44-56.
  107. ║BETTER         ║  Is KWIC BETTER than KWOC? Index methods compared. ASIS Nov 1982 pg. 44-56.
  108. ║COMPANIES      ║  Are KWIC indexes actually promoted by paper COMPANIES? True Stories Nov 88
  109. ║COMPARED       ║  Is KWIC better than KWOC? Index methods COMPARED. ASIS Nov 1982 pg. 44-56.
  110. ║EDGE           ║  Fixing your Leading EDGE PC Popular Mechanics Nov 79, p. 43-4
  111. ║FIXING         ║  FIXING your Leading Edge PC Popular Mechanics Nov 79, p. 43-4
  112. ║GMUTANT        ║  Who says you need a mainframe for KWIC indexing GMUTANT News Jan 89 page 2
  113. ║INDEX          ║  Is KWIC better than KWOC? INDEX methods compared. ASIS Nov 1982 pg. 44-56.
  114. ║INDEXES        ║  Are KWIC INDEXES actually promoted by paper companies? True Stories Nov 88
  115.  
  116. What happens is pretty simple--although while developing ZK I began to wonder
  117. if it was impossible.  All the lines in your original file are rotated,
  118. with a unique word highlighted each time.  Actually, not every word--you may
  119. select up to 400 words (stopwords) which will not appear as main headings
  120. in your final KWIC or KWOC listing.
  121.  
  122. When finished, simply print out the final file using your word processor,
  123. program editor, or the DOS type command.
  124.  
  125. As you can see, KWIC indexing creates rather large files.  The sample at
  126. the beginning of this introduction grew from 4 to 38 lines.  To keep this
  127. growth manageable, use your stopword list often and wisely.
  128.  
  129. Performance:
  130.  
  131. ZK produces a KWOC index of a 217 line input file in 1 minute
  132. (running on a DELL 310 (386/20Mhz) with disk caching).
  133.  
  134. Files included:
  135.  
  136. ZKSTOP.LST -  Your list of stopwords.  Comments inside this
  137.               text file explain its use.  Read all comments
  138.               before you modify the list.
  139.  
  140. ZK.DOC -      This documentation file
  141.  
  142. ZK.EXE -      The program.
  143.  
  144. TESTFILE     - A sample file used to generate a sample KWIC
  145.                or KWOC index.  To see a KWIC file,  enter
  146.                ZKWIC TESTFILE at the DOS prompt. For a KWOC
  147.                version, enter ZKWOC TESTFILE.
  148.  
  149.  
  150.  
  151.  
  152.     ZK processing will add about 15 characters to your lines, so
  153.     plan accordingly.  We've found that with a printer capable of
  154.     putting 120 lines on a page, a line limit of 100 characters in
  155.     your input file works well.
  156.  
  157. b.  There is no limit on the length of your input file...although
  158.     realize that your KWIC/KWOC  indexes will be approximately 10 times
  159.     larger than your original file (since each word gets its own
  160.     line in the final product).
  161.  
  162. c.  If you're entering book or journal titles, use a standard form
  163.     of abbreviation for things like page, date, volume no, and the
  164.     like.  If you're consistent with these, you'll only need one
  165.     entry in your stoplist to purge them as main entries in your
  166.     final product.  Also, leave a space between things like pg.
  167.     and the number (e.g., pg. 7). That way the 7 won't become
  168.     a part of the word pg.--and fool ZK. Some people like to end
  169.     each entry in a KWIC index with some sort of character denoting the
  170.     end of the string.  For example, I've found that putting '>>' on
  171.     the end of each line in the input file improves readability
  172.     (since you can see where the line logically begins...
  173.  
  174.      p. 7>> Why Indexers ║GO           ║crazy early in Life ASIS v7n2
  175.     Routines for Evening ║HOURS        ║80 Micro Apr 79, p. 4>> Sort
  176.  
  177. d.  Your input file must be plain ASCII text.
  178.  
  179. e.  There's no minimum limit for line length in your input file.
  180.     Lines shorter than the 35 characters will be padded as
  181.     necessary--to insure that the highlighted word appears
  182.     within the vertical lines on KWIC indexes.
  183.  
  184. Step 2. Check your stoplist.
  185.  
  186. ZKSTOP.LST is an ASCII file that contains your stop list; that is,
  187. words that may appear in your final product but words that you do
  188. not want highlighted in the MAIN HEADING area.
  189.  
  190. In practice you may well discover that it is best to customize your
  191. stoplist for a given index--some words will be common to a particular
  192. data file but not so common otherwise. Note that the more words you
  193. add to ZKSTOP.LST, the slower ZK will run--it has more possibilities
  194. to check as it moves through the file...
  195.  
  196.  
  197.  
  198. Here's an excerpt of ZKSTOP.LST as distributed:
  199.  
  200. -------------------
  201.  
  202. THE
  203. OF
  204. A
  205. BY
  206. PG
  207. * You may purge numbers listing as MAIN HEADINGS by entering the
  208. * first digit of a number and putting a + sign after it.  For
  209. * example, 1+ will purge 1, 10, 199, 1324234234 and so on.
  210. * If you omit the '+' sign, ZKSTOP will only purge the
  211. * single digit, not any digit that begins with that number.
  212. 1+
  213. 2+
  214. 3+
  215. 4+
  216. * END OF ZKSTOP.LST
  217.  
  218. -----------------------
  219. You may put comments in ZKSTOP.LST, just include a '*' in the line
  220. with the comment.  ANY line that contains a * will be ignored, so don't
  221. put words with *'s in them in your list--they won't be stopped.
  222.  
  223. If you should lose or destroy ZKSTOP.LST, you may recreate it.
  224. It must be a plain ASCII file with one word on a line. The
  225. last line in the file must be a comment (to signal ZK that
  226. the end of the file has been reached). You may have up to 400
  227. words in this file, but no word may be longer than 20 characters.
  228.  
  229. Here's what happens if you omit stopword processing (or leave out
  230. number-stopping in your list):
  231.  
  232. Popular Mechanics Nov |79,        |p. 43-4 Fixing your Leading Edge PC
  233. ies? True Stories Nov |88         |Are KWIC indexes actually promoted
  234. xing GMUtant News Jan |89         |page 2 Who says you need a mainframe 
  235.  
  236. The highlighting of 79, 88, and 89 isn't very informative.
  237.  
  238.  
  239. Other notes:
  240.  
  241. When creating a KWOC index, ZK will trim punctuation off the end of the
  242. keyword but will leave any other punctuation that occurs intact.
  243.  
  244. Be sure you have about 12 times the disk space required to store your
  245. input file before beginning ZK.  
  246.  
  247. The fewer stop words you have, the faster ZK will run.
  248.  
  249.  
  250.  
  251. Another GMUtant Software product you might find interesting:
  252.  
  253. BIBL (rhymes with nibble). A full-featured personal library management
  254.      system. BIBL's features include: full mouse support, ASCII import/
  255.      export, bibliography production, multiple databases, may be
  256.      run in read-only mode if desired, boolean (and/or/not) searching,
  257.      support for external editor/viewer programs, data import from
  258.      CD-ROM downloads and more. Registered version adds EMS storage
  259.      of indexes, use of WordPerfect as editor/printer, global find & replace
  260.      on any field, and more.
  261.  
  262.      BIBL matches up well with ProCite and other bibliographic
  263.      packages. BIBL is available via Public Software Library, the
  264.      GMUtant OnLine BBS, or CompuServe (IBMAPPS forum).
  265.  
  266.      Current release: 5.70
  267.  
  268. Questions? Comments?
  269.  
  270. C.W.Grotophorst
  271. Phone: (703) 993-2239
  272. BBS: (703) 993-2219  24 hrs per day, 1200/2400/9600 v.32
  273. Bitnet: WALLYG@GMUVAX
  274. CompuServe: 70404,3376
  275.  
  276.  
  277.